<?php
/**
 * LoginForm class file
 */

/**
 * LoginForm class.
 *
 * LoginForm is the data structure for keeping
 * user login form data. It is used by the 'login' action of 'SiteController'.

 * @uses CFormModel
 * @package 
 * @version $Rev: 7 $
 * @author Joachim Werner <joachim.werner@diggin-data.de>
 */
class LoginForm extends CFormModel
{
    public $username;
    public $password;
    public $rememberMe;

    private $_identity;

    /**
     * Declares the validation rules.
     * The rules state that username and password are required,
     * and password needs to be authenticated.
     */
    public function rules()
    {
        return array(
            // username and password are required
            array('username, password', 'required'),
            // rememberMe needs to be a boolean
            array('rememberMe', 'boolean'),
            // password needs to be authenticated
            array('password', 'authenticate', 'skipOnError'=>true),
        );
    }

    /**
     * Declares attribute labels.
     */
    public function attributeLabels()
    {
        return array(
            'username'      => Yii::t('site','User ID'),
            'password'      => Yii::t('site','Password'),
            'rememberMe'    => Yii::t('site','Remember Login'),
        );
    }

    /**
     * Authenticates the password.
     * This is the 'authenticate' validator as declared in rules().
     */
    public function authenticate($attribute,$params)
    {
        $this->_identity=new UserIdentity($this->username,$this->password);
        if(!$this->_identity->authenticate())
        {
            switch($this->_identity->errorCode)
            {
                case UserIdentity::ERROR_USERNAME_INVALID:
                    $this->addError('username','Incorrect username.');
                    break;
                case UserIdentity::ERROR_PASSWORD_INVALID:
                    $this->addError('password','Incorrect password.');
                    break;
                case UserIdentity::ERROR_REGISTRATION_NOT_COMPLETED:
                    $this->addError('username',"Registration wasn't completed for this username.");
                    break;
                default:
                    $this->addError('username',"Other lofin error.");
                    break;
            }
        }
    }

    /**
     * Logs in the user using the given username and password in the model.
     * @return boolean whether login is successful
     */
    public function login()
    {
        if($this->_identity===null)
        {
            $this->_identity=new UserIdentity($this->username,$this->password);
            $this->_identity->authenticate();
        }
        if($this->_identity->errorCode===UserIdentity::ERROR_NONE)
        {
            $duration=$this->rememberMe ? 3600*24*30 : 0; // 30 days
            Yii::app()->user->login($this->_identity,$duration);
            return true;
        }
        else
            return false;
    }
}
